<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Report Item UI Extension Point</title>
<style type="text/css">@import url("file:/C:/JAHT/eclipse/plugins/org.eclipse.platform_3.3.200.v200908070800/book.css");</style>
<style type="text/css">@import url("file:/C:/JAHT/eclipse/configuration/org.eclipse.osgi/bundles/170/1/.cp/schema.css");</style>
</HEAD>
<BODY>
<H1 style="text-align:center">Report Item UI Extension Point</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.birt.report.designer.ui.reportitemUI<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>1.0
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>This extension point is used in conjunction with the Report Item extension point defined in the model. It is used to register the GUI to be used for the Extended report item.<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> ((<a href="#e.reportItemFigureUI">reportItemFigureUI</a> | <a href="#e.reportItemLabelUI">reportItemLabelUI</a> | <a href="#e.reportItemImageUI">reportItemImageUI</a>) , <a href="#e.model">model</a> , <a href="#e.builder">builder</a>? , <a href="#e.palette">palette</a>? , <a href="#e.editor">editor</a>? , <a href="#e.outline">outline</a>? , <a href="#e.description">description</a>?)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.model">model</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST model</p>
<p class="code SchemaDtdAttlist">extensionName&nbsp;CDATA #REQUIRED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>extensionName</b> - The ROM Report Item Extension name that maps to this UI</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.reportItemFigureUI">reportItemFigureUI</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST reportItemFigureUI</p>
<p class="code SchemaDtdAttlist">class&nbsp;CDATA #REQUIRED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>class</b> - a fully qualified name of the Java class implementing org.eclipse.birt.report.designer.ui.extensions.IReportItemFigureUI</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.reportItemLabelUI">reportItemLabelUI</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST reportItemLabelUI</p>
<p class="code SchemaDtdAttlist">class&nbsp;CDATA #REQUIRED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>class</b> - a fully qualified name of the Java class implementing org.eclipse.birt.report.designer.ui.extensions.IReportItemLabelUI</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.reportItemImageUI">reportItemImageUI</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST reportItemImageUI</p>
<p class="code SchemaDtdAttlist">class&nbsp;CDATA #REQUIRED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>class</b> - a fully qualified name of the Java class implementing org.eclipse.birt.report.designer.ui.extensions.IReportItemImageUI</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.builder">builder</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST builder</p>
<p class="code SchemaDtdAttlist">class&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
Optional Builder for the element inside the Editor. Instantiated when a new item is dragged from the palette inside the editor.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>class</b> - a fully qualified name of the Java class implementing org.eclipse.birt.report.designer.ui.extensions.IReportItemBuilderUI</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.palette">palette</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST palette</p>
<p class="code SchemaDtdAttlist">icon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">category&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">categoryDisplayName&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>icon</b> - The icon to show in the Palette</li>
<li><b>category</b> - Indicates in which category the icon should appear in the Palette. If it is an non-existing category, a new one will be created for this report item.</li>
<li><b>categoryDisplayName</b> - Display name of the category if this category does not exist in BIRT. If it does already exist, this will be ignored.</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.editor">editor</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST editor</p>
<p class="code SchemaDtdAttlist">showInMasterPage&nbsp;(true | false) "true"</p><p class="code SchemaDtdAttlist">showInDesigner&nbsp;&nbsp;&nbsp;(true | false) "true"</p><p class="code SchemaDtdAttlist">canResize&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(true | false) "true"</p><p class="code SchemaDtdAttlist">menuLabel&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>showInMasterPage</b> - True if the element UI is to be shown in the MasterPage and MasterPage's Palette</li>
<li><b>showInDesigner</b> - True if the element UI is to be shown in the Designer and the Designer's Palette</li>
<li><b>canResize</b> - Boolean indicating if the element can be resized inside the editor area</li>
<li><b>menuLabel</b> - An optional text that will be display for menu item if applicable.</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.outline">outline</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST outline</p>
<p class="code SchemaDtdAttlist">icon&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>icon</b> - The icon to show in the Outline View</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.description">description</a> (#PCDATA)&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
an optional subelement whose body contains a short text describing what the UI extension will do</p>
<br><br>
<h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>The following is an example of the extented element UI extension point:
<p><pre class="Example"><span class="code SchemaTag">

&lt;extension point=</span><span class="code SchemaCstring">&quot;org.eclipse.birt.report.designer.reportitemUI&quot;</span><span class="code SchemaTag">&gt;
 &lt;model extensionName=</span><span class="code SchemaCstring">&quot;chart&quot;</span><span class="code SchemaTag">/&gt;
 &lt;reportItemFigureUI  class==</span><span class="code SchemaCstring">&quot;org.eclipse.birt.chart.ChartAdapterUI&quot;</span><span class="code SchemaTag">/&gt;
 &lt;palette icon=</span><span class="code SchemaCstring">&quot;/icons/paletteimage.gif&quot;</span><span class="code SchemaTag"> category=</span><span class="code SchemaCstring">&quot;main&quot;</span><span class="code SchemaTag">/&gt;
 &lt;editor showInMasterPage=</span><span class="code SchemaCstring">&quot;false&quot;</span><span class="code SchemaTag">/&gt;
 &lt;outline icon=</span><span class="code SchemaCstring">&quot;/icons/outlineimage.gif&quot;</span><span class="code SchemaTag">/&gt;
&lt;/extension&gt;

</span></pre></p>
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>The report item UI extension may implement the interfaces defined in the <i>org.eclipse.birt.report.designer.ui.extensions</i> package. See the package's JavaDoc documentation and API interfaces for more information.
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>The plugin <i>org.eclipse.birt.chart.reportitem</i>, supplied with the BIRT installation, provides a good example for implementing a report item UI extension.
<br>
<p></p>

<br>
<p class="note SchemaCopyright">
Copyright (c) 2005 Actuate Corporation. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-2.0.html

Contributors: Actuate Corporation - initial API and implementation

</p>
</BODY>
</HTML>
